Alle geplanten Pläne abrufen

Version 3.1.23.2

Alle geplanten Pläne auflisten

Gibt alle geplanten Pläne zurück, die zum Aufrufer oder bestimmten Nutzer gehören.

Wenn keine user_id angegeben ist, werden über diese Funktion die geplanten Pläne des Aufrufers zurückgegeben.

Übergeben Sie all_users=true, um alle Zeitpläne für alle Nutzer aufzulisten.

Der Anrufer muss die Berechtigung see_schedules haben, um die geplanten Pläne anderer Nutzer zu sehen.

Anfrage

GET /scheduled_plans

Datentyp

Beschreibung

Anfrage

HTTPRequest

Abfrage

HTTP-Abfrage

HTTPQuery-Definition maximieren...

user_id

integer

Gibt geplante Pläne für diese user_id zurück. Wenn nicht angegeben, werden geplante Pläne zurückgegeben, die dem Aufrufer gehören.

Felder

String

Durch Kommas getrennte Liste von Feldnamen. Wenn angegeben, sind nur die angegebenen Felder in der Antwort enthalten

alle_nutzer

boolean

Geplante Pläne aller Nutzer zurückgeben (Aufrufer benötigt die Berechtigung „see_schedules“)

Antwort

200: Geplanter Plan

Datentyp

Beschreibung

(Array)

Geplanter Plan[]

name

String

Name dieses Plans

user_id

integer

Nutzer-ID, zu der dieser Plan gehört

Run_as_Recipient

boolean

Ob der Zeitplan als Empfänger ausgeführt wird (gilt nur für E-Mail-Empfänger)

aktiviert

boolean

Gibt an, ob der Planplan aktiviert ist

Look_ID

integer

ID eines Looks

Dashboard-ID

integer

ID eines Dashboards

Lookml-Dashboard_ID

String

ID eines LookML-Dashboards

Filterstring

String

Abfragestring zur Ausführung des Looks oder Dashboards

Dashboard_Filter

String

(VERWORFEN) Alias für das Feld „filter_string“

Anforderungsergebnisse

boolean

Die Auslieferung sollte erfolgen, wenn beim Ausführen des Dashboards oder Ergebnisses Ergebnisse zurückgegeben werden

no_no_results erforderlich

boolean

Die Auslieferung sollte erfolgen, wenn im Dashboard keine Ergebnisse zurückgegeben werden

Änderung erforderlich

boolean

Die Auslieferung sollte erfolgen, wenn sich Daten seit der letzten Ausführung geändert haben

Ergebnisse_alle_senden

boolean

Es wird eine unbegrenzte Abfrage ausgeführt und alle Ergebnisse werden gesendet.

Crontab

String

Vixie-Style-Crontab-Spezifikation für die Ausführung

Datengruppe

String

Name einer Datengruppe; sofern angegeben, wird sie ausgeführt, wenn die Gruppe ausgelöst wurde (kann nicht mit Cron-String verwendet werden)

Zeitzone

String

Zeitzone zur Interpretation des angegebenen Crontabs (Standardeinstellung ist die Looker-Instanzzeitzone)

Abfrage-ID

String

Abfrage-ID

geplantes_Ziel

Geplanter Plan[]

GeplantePlan-Zieldefinition maximieren...

integer

Eindeutige ID

Plan_ID

integer

ID eines Plans, dessen Inhaber Sie sind

Format

String

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

boolean

Sind die Werte formatiert? (einschließlich Währungssymbolen, Zifferntrennzeichen usw.)

"bewerben"

boolean

Gibt an, ob Visualisierungsoptionen auf die Ergebnisse angewendet werden.

adresse

String

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

boolean

Ob der Empfänger ein Looker-Nutzer auf der aktuellen Instanz ist (nur für E-Mail-Empfänger gilt)

Typ

String

Typ der Adresse („E-Mail“, „Webhook“, „s3“ oder „sftp“)

Parameter

String

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

String

(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

String

Optionale Nachricht, die in geplante E-Mails aufgenommen werden soll

einmal ausführen

boolean

Ob der betreffende Plan nur einmal ausgeführt werden soll (normalerweise für Tests)

Links einfügen

boolean

Gibt an, ob Links zu Looker in diesen Plan aufgenommen werden sollen

Benutzerdefinierte_URL_Basis

String

Domain der benutzerdefinierten URL für die geplante Entität

Benutzerdefinierte URL-Parameter

String

Benutzerdefinierter URL-Pfad und Parameter für die geplante Entität

Benutzerdefiniertes_URL-Label

String

Benutzerdefiniertes URL-Label für die geplante Entität

Benutzerdefinierte_URL

boolean

Gibt an, ob der benutzerdefinierte Link statt des Standard-Looker-Links angezeigt werden soll

PDF_papiergröße

String

Das Papierformat der PDF-Datei muss entsprechend formatiert sein. Gültige Werte sind: „letter“, „legal“, „tabloid“, „a0“, „a1“, „a2“, „a3“, „a4“, „a5“.

PDF_Querformat

boolean

Ob die PDF-Datei im Querformat formatiert werden soll

eingebettetes Objekt

boolean

Ob dieser Zeitplan in einem eingebetteten Kontext liegt oder nicht

Farbdesign

String

Farbschema des Dashboards, falls zutreffend

Lange_Tabellen

boolean

Gibt an, ob die Tabellenansicht auf volle Länge erweitert werden soll

Inline-Tabellenbreite

integer

Die Pixelbreite, in der die Inline-Tabellenvisualisierungen gerendert werden

integer

Eindeutige ID

erstellt am

String

Datum und Uhrzeit der Erstellung des "geplanten Plans"

Aktualisiert am

String

Datum und Uhrzeit der letzten Aktualisierung von "GeplantePlan"

title

String

Titel

Nutzer

NutzerÖffentlich

Nutzer, der Inhaber dieses Plans ist

UserPublic-Definition maximieren...

kann

Objekt

Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann

integer

Eindeutige ID

first_name

String

Vorname

last_name

String

Nachname

display_name

String

Vollständiger Name für Anzeige (nur verfügbar, wenn sowohl „first_name“ als auch „last_name“ festgelegt sind)

Avatar-URL

String

URL für das Avatarbild (möglicherweise generisch)

URL

String

Link zum Abrufen dieses Artikels

nächste_Run_at

String

Wann der GeplantePlan als Nächstes ausgeführt wird (bei einmaliger Ausführung null)

Letzter_Durchlauf

String

Wann der GeplantePlan zuletzt ausgeführt wurde

kann

Objekt

Vorgänge, die der aktuelle Nutzer für dieses Objekt ausführen kann

400: Ungültige Anfrage

Datentyp

Beschreibung

(Objekt)

Fehler

nachricht

String

Fehlerdetails

Dokumentations-URL

String

Link zur Dokumentation

404: Nicht gefunden

Datentyp

Beschreibung

(Objekt)

Fehler

nachricht

String

Fehlerdetails

Dokumentations-URL

String

Link zur Dokumentation

422: Validierungsfehler

Datentyp

Beschreibung

(Objekt)

Validierungsfehler

nachricht

String

Fehlerdetails

Fehler

Validierungsfehler[]

ValidationErrorDetail-Definition maximieren...

Feld

String

Feld mit Fehler

Code

String

Fehlercode

nachricht

String

Fehlermeldung

Dokumentations-URL

String

Link zur Dokumentation

Dokumentations-URL

String

Link zur Dokumentation

Beispiele

Alle geplanten Pläne abrufen

Alle geplanten Pläne auflisten

Anfrage

Antwort

200: Geplanter Plan

400: Ungültige Anfrage

404: Nicht gefunden

422: Validierungsfehler

Beispiele

Python

TypeScript

Kotlin

Swift