Version 4.0.23.6 (neueste Version)
Informationen zu einem geplanten Plan abrufen
Administratoren können Informationen zu den geplanten Plänen anderer Nutzer abrufen.
Anfrage
GET
/scheduled_plans/{scheduled_plan_id}
Datentyp
Beschreibung
Anfrage
Pfad
HTTPPath-Definition maximieren...
Plan_ID
ID des geplanten Plans
Abfrage
HTTPQuery-Definition maximieren...
Felder
Angeforderte Felder.
Antwort
200: Geplanter Plan
Datentyp
Beschreibung
(Objekt)
name
Name dieses Plans
user_id
Nutzer-ID, zu der dieser Plan gehört
Run_as_Recipient
Ob der Zeitplan als Empfänger ausgeführt wird (gilt nur für E-Mail-Empfänger)
aktiviert
Gibt an, ob der Planplan aktiviert ist
Look_ID
ID eines Looks
Dashboard-ID
ID eines Dashboards
Lookml-Dashboard_ID
ID eines LookML-Dashboards
Filterstring
Abfragestring zur Ausführung des Looks oder Dashboards
Dashboard_Filter
(VERWORFEN) Alias für das Feld „filter_string“
Anforderungsergebnisse
Die Auslieferung sollte erfolgen, wenn beim Ausführen des Dashboards oder Ergebnisses Ergebnisse zurückgegeben werden
no_no_results erforderlich
Die Auslieferung sollte erfolgen, wenn im Dashboard keine Ergebnisse zurückgegeben werden
Änderung erforderlich
Die Auslieferung sollte erfolgen, wenn sich Daten seit der letzten Ausführung geändert haben
Ergebnisse_alle_senden
Es wird eine unbegrenzte Abfrage ausgeführt und alle Ergebnisse werden gesendet.
Crontab
Vixie-Style-Crontab-Spezifikation für die Ausführung
Datengruppe
Name einer Datengruppe; sofern angegeben, wird sie ausgeführt, wenn die Gruppe ausgelöst wurde (kann nicht mit Cron-String verwendet werden)
Zeitzone
Zeitzone zur Interpretation des angegebenen Crontabs (Standardeinstellung ist die Looker-Instanzzeitzone)
Abfrage-ID
Abfrage-ID
geplantes_Ziel
GeplantePlan-Zieldefinition maximieren...
id
lock
Eindeutige ID
Plan_ID
ID eines Plans, dessen Inhaber Sie sind
Format
Das Datenformat, das an das angegebene Ziel gesendet werden soll. Die unterstützten Formate variieren je nach Ziel, umfassen aber „txt“, „csv“, „inline_json“, „json“, „json_detail“, „XLSx“, „html“, „wysiwyg_pdf“, „kompiliered_pdf“, „wysiwyg_png“
"formatieren" anwenden
Sind die Werte formatiert? (einschließlich Währungssymbolen, Zifferntrennzeichen usw.)
"bewerben"
Gibt an, ob Visualisierungsoptionen auf die Ergebnisse angewendet werden.
adresse
Adresse des Empfängers. Für E-Mail-Adressen, z.B. „nutzer@beispiel.de“. Für Webhooks, z.B. „https://examle.domain/path“. Für Amazon S3, z.B. „s3://bucket-name/path/“. Für SFTP, z.B. „sftp://host-name/pfad/“.
Empfänger
lock
Ob der Empfänger ein Looker-Nutzer auf der aktuellen Instanz ist (nur für E-Mail-Empfänger gilt)
Typ
Typ der Adresse („E-Mail“, „Webhook“, „s3“ oder „sftp“)
Parameter
JSON-Objekt, das Parameter für die externe Planung enthält. Für Amazon S3 sind dafür Schlüssel und Werte für „access_key_id“ und „region“ erforderlich. Bei SFTP sind für den Nutzernamen ein Schlüssel und ein Wert erforderlich.
Secret-Parameter
(Nur Schreibzugriff) JSON-Objekt mit geheimen Parametern für externe Planung. Für Amazon S3 sind ein Schlüssel und ein Wert für „secret_access_key“ erforderlich. Bei SFTP sind dafür ein Schlüssel und ein Wert für das Passwort erforderlich.
nachricht
Optionale Nachricht, die in geplante E-Mails aufgenommen werden soll
einmal ausführen
Ob der betreffende Plan nur einmal ausgeführt werden soll (normalerweise für Tests)
Links einfügen
Gibt an, ob Links zu Looker in diesen Plan aufgenommen werden sollen
Benutzerdefinierte_URL_Basis
Domain der benutzerdefinierten URL für die geplante Entität
Benutzerdefinierte URL-Parameter
Benutzerdefinierter URL-Pfad und Parameter für die geplante Entität
Benutzerdefiniertes_URL-Label
Benutzerdefiniertes URL-Label für die geplante Entität
Benutzerdefinierte_URL
Gibt an, ob der benutzerdefinierte Link statt des Standard-Looker-Links angezeigt werden soll
PDF_papiergröße
Das Papierformat der PDF-Datei muss entsprechend formatiert sein. Gültige Werte sind: „letter“, „legal“, „tabloid“, „a0“, „a1“, „a2“, „a3“, „a4“, „a5“.
PDF_Querformat
Ob die PDF-Datei im Querformat formatiert werden soll
eingebettetes Objekt
Ob dieser Zeitplan in einem eingebetteten Kontext liegt oder nicht
Farbdesign
Farbschema des Dashboards, falls zutreffend
Lange_Tabellen
Gibt an, ob die Tabellenansicht auf volle Länge erweitert werden soll
Inline-Tabellenbreite
Die Pixelbreite, in der die Inline-Tabellenvisualisierungen gerendert werden
id
lock
Eindeutige ID
erstellt am
lock
Datum und Uhrzeit der Erstellung des "geplanten Plans"
Aktualisiert am
lock
Datum und Uhrzeit der letzten Aktualisierung von "GeplantePlan"
title
lock
Titel
Nutzer
lock
Nutzer, der Inhaber dieses Plans ist
UserPublic-Definition maximieren...
kann
lock
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann
id
lock
Eindeutige ID
first_name
lock
Vorname
last_name
lock
Nachname
display_name
lock
Vollständiger Name für Anzeige (nur verfügbar, wenn sowohl „first_name“ als auch „last_name“ festgelegt sind)
Avatar-URL
lock
URL für das Avatarbild (möglicherweise generisch)
URL
lock
Link zum Abrufen dieses Artikels
nächste_Run_at
lock
Wann der GeplantePlan als Nächstes ausgeführt wird (bei einmaliger Ausführung null)
Letzter_Durchlauf
lock
Wann der GeplantePlan zuletzt ausgeführt wurde
kann
lock
Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann
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
Beispiele
Ruby
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/rerun_failed_email_schedules.rb |
Kotlin
https://github.com/looker-open-source/sdk-codegen/Blob/main/kotlin/src/test/TestMethods.kt |