Obtenir un forfait planifié

Version 4.0.23.2

Obtenir des informations sur un forfait planifié

Les administrateurs peuvent récupérer des informations sur les forfaits planifiés des autres utilisateurs.

Demande

GET /schedule_plans/{schedule_plan_id}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
id_plan_planifié
string
ID du plan planifié
query
Requête HTTP
Développer la définition de la requête HTTP...
champs
string
Champs demandés.

Réponse

200: Plan planifié

Type de données
Description
(objet)
name
string
Nom de ce plan planifié
user_id
string
ID utilisateur auquel appartient ce forfait planifié
exécution en tant que destinataire
booléen
Si la planification est exécutée en tant que destinataire (s'applique uniquement aux destinataires de l'e-mail)
activé
booléen
Si l'option "Plan planifié" est activée
id_look
string
ID d'un style
id_tableau_de_bord
string
ID d'un tableau de bord
id_tableaudetableau_de_lookml
string
ID d'un tableau de bord LookML
chaîne_filtres
string
Chaîne de requête avec laquelle exécuter l'apparence ou le tableau de bord
tableaux_de_filtres
string
(OBSOLÈTE) Alias du champ "filter_string"
nécessite_résultats
booléen
La diffusion doit avoir lieu si l'exécution du tableau de bord ou l'apparence renvoie des résultats
nécessite_aucun_résultats
booléen
La diffusion doit avoir lieu si le tableau de bord ne renvoie pas de résultats
Exiger_modifier
booléen
La diffusion devrait avoir lieu si les données ont changé depuis la dernière exécution
envoyer_tous_résultats
booléen
Exécute une requête illimitée et envoie tous les résultats.
Croncrontab
string
Spécification crontab de style Vixie lors de l'exécution
groupe de données
string
Nom d'un groupe de données ; s'il est spécifié, il s'exécute lorsque le groupe de données est déclenché (il ne peut pas être utilisé avec une chaîne Cron).
fuseau horaire
string
Fuseau horaire pour l'interprétation du crontab spécifié (par défaut, le fuseau horaire de l'instance Looker).
id_requête
string
ID de la requête
destination_plan_planifié
Développer la définition de SchedulingPlanDestination...
id
string
Identifiant unique
id_plan_planifié
string
ID d'un forfait planifié que vous possédez
format
string
Format de données à envoyer à la destination donnée. Les formats acceptés varient selon la destination, mais incluent les éléments suivants: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assemblyd_pdf" et "wysiwyg_png"
Appliquer le format
booléen
Les valeurs sont-elles formatées ? (contenant des symboles de devise, des séparateurs numériques, etc.)
appliquer_vis
booléen
Indique si les options de visualisation sont appliquées aux résultats.
address
string
Adresse du destinataire. Pour les e-mails, par exemple "utilisateur@example.com". Pour les webhooks, par exemple "https://examle.domain/path". Pour Amazon S3, par exemple "s3://nom-bucket/chemin/". Pour SFTP (par exemple, "sftp://nom-hôte/chemin/").
looker_recipient
booléen
Indique si le destinataire est un utilisateur Looker sur l'instance actuelle (applicable uniquement aux destinataires de l'e-mail)
type
string
Type d'adresse ("email", "webhook", "s3" ou "sftp")
paramètres
string
Objet JSON contenant des paramètres de planification externe. Pour Amazon S3, cela nécessite des clés et des valeurs pour access_key_id et region. Pour SFTP, vous devez saisir une clé et une valeur pour le nom d'utilisateur.
paramètres_secrets
string
(Écriture seule) Objet JSON contenant des paramètres secrets pour la planification externe. Pour Amazon S3, cela nécessite une clé et une valeur pour secret_access_key. Pour SFTP, vous devez saisir une clé et une valeur pour le mot de passe.
Message
string
Message facultatif à inclure dans les e-mails planifiés
course à pied une fois
booléen
Indique si le plan en question ne doit être exécuté qu'une seule fois (généralement pour les tests).
Inclure les liens
booléen
Indique si les liens vers Looker doivent être inclus dans ce plan planifié
base_url_personnalisée
string
Domaine d'URL personnalisée pour l'entité programmée
custom_url_params (paramètres d'URL personnalisés)
string
Chemin de l'URL personnalisée et paramètres pour l'entité programmée
libellé_url_personnalisée
string
Libellé d'URL personnalisée pour l'entité programmée
afficher_url_personnalisée
booléen
Indique s'il faut afficher le lien personnalisé en lieu et place du lien standard
Taille du papier au format PDF
string
Format de papier du PDF. Les valeurs valides sont "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4" et "a5".
paysage PDF
booléen
Indique si le PDF doit être au format paysage
incorporation
booléen
Indique si cette programmation est intégrée ou non
thème_couleur
string
Jeu de couleurs du tableau de bord, le cas échéant
tables_longues
booléen
Indique si la table doit être affichée en entier
inline_table_width
integer
Largeur de pixel à laquelle les visualisations du tableau intégré sont affichées
id
string
Identifiant unique
créé le
string
Date et heure de création de SchedulePlan
mis à jour le
string
Date et heure de la dernière mise à jour de SchedulingPlan.
title
string
Titre
user
Utilisateur propriétaire de ce plan planifié
Développer la définition UserPublic...
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
string
Identifiant unique
first_name
string
Prénom
last_name
string
Nom
display_name
string
Nom complet à afficher (disponible uniquement si prénom et nom)
avatar
string
URL de l'avatar (peut être générique)
url
string
Lien pour obtenir cet élément
Prochaine course
string
Date d'exécution du plan planifié (null s'il s'exécute une fois)
Dernière exécution
string
Date de la dernière exécution du plan planifié
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet

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

Examples