Obtenir Workspace

Version 3.1.23.2

Obtenir un espace de travail

Renvoie des informations sur un espace de travail telles que l'état de Git et les branches sélectionnées de tous les projets disponibles pour le compte utilisateur de l'appelant.

Un espace de travail définit les versions des fichiers de projet qui seront utilisées pour évaluer les expressions et les opérations qui utilisent des définitions de modèle, telles que l'exécution de requêtes ou l'affichage de tableaux de bord. Chaque projet possède son propre dépôt Git. Chaque projet d'un espace de travail peut être configuré pour référencer une branche ou une révision particulière dans leurs dépôts respectifs.

Deux espaces de travail prédéfinis sont disponibles: "production" et "dev".

L'espace de travail de production est partagé entre tous les utilisateurs de Looker. Les modèles de l'espace de travail de production sont en lecture seule. Pour modifier des fichiers en production, il suffit de modifier les fichiers d'une branche Git et d'utiliser les requêtes d'extraction pour fusionner les modifications de la branche "dev" dans la branche "production", puis de demander à Looker de se synchroniser avec la production.

L'espace de travail de développement est local pour chaque utilisateur de Looker. Les modifications apportées aux fichiers de projet/modèle dans l'espace de travail de développement ne s'appliquent qu'à cet utilisateur, et uniquement lorsque l'espace de travail de développement est sélectionné comme espace de travail actif pour la session d'API. (voir set_session_workspace()).

L'espace de travail de développement n'est PAS unique pour une session d'API. Deux applications accédant à l'API Looker à l'aide du même compte utilisateur verront les mêmes fichiers dans l'espace de travail de développement. Pour éviter les conflits entre les clients API, il est préférable que chaque client se connecte avec des identifiants API3 pour un compte utilisateur différent.

Les modifications apportées aux fichiers d'un espace de travail de développement sont persistantes dans les sessions d'API. Nous vous recommandons de valider toutes les modifications que vous avez apportées au dépôt Git, mais qui ne sont pas strictement obligatoires. Vos fichiers modifiés se trouvent dans un répertoire spécifique à l'utilisateur sur le serveur Looker. Ils seront toujours présents lorsque vous vous reconnecterez ultérieurement et que vous utiliserez update_session(workspace_id: "dev") pour sélectionner l'espace de travail de développement pour la nouvelle session d'API.

Demande

GET /workspaces/{workspace_id}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
Workspace_id
string
ID de l'espace de travail

Réponse

200: Workspace

Type de données
Description
(objet)
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
string
ID unique de cet espace de travail utilisateur. Les ID d'espace de travail prédéfinis incluent "production" et "dev"
projects
Projet[]
Développer la définition du projet...
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
string
ID du projet
name
string
Nom à afficher pour le projet
utilise_git
booléen
Si la valeur est "true", le projet est configuré avec un dépôt Git
git_remote_url
string
URL du dépôt distant Git
git_username
string
Nom d'utilisateur Git pour l'authentification HTTPS. (En production uniquement si vous utilisez des attributs utilisateur)
git_password
string
Mot de passe Git (écriture seule) pour l'authentification HTTPS. (En production uniquement si vous utilisez des attributs utilisateur)
Git_production_branch_name
string
Nom de la branche de production Git. La valeur par défaut est "master". Uniquement compatible avec Looker 21.0 et les versions ultérieures.
utiliser_git_cookie_auth
booléen
Si la valeur est "true", le projet utilise un cookie Git pour l'authentification.
git_username_user_attribute
string
Nom de l'attribut utilisateur pour le nom d'utilisateur dans l'authentification HTTPS par utilisateur.
git_password_user_attribute
string
Nom de l'attribut utilisateur pour le mot de passe dans l'authentification HTTPS par utilisateur.
git_service_name (nom du service Git)
string
Nom du fournisseur de services Git
git_serveur_d'applications_http_port
integer
Port sur lequel le serveur d'applications HTTP(S) s'exécute (pour les relations publiques, la navigation de fichiers, etc.)
git_application_server_http_scheme
string
Scheme en cours d'exécution sur le serveur d'applications (pour les relations publiques, la navigation de fichiers, etc.)
déployer_secret
string
(Écriture seule) Jeton secret facultatif avec lequel authentifier les requêtes vers le point de terminaison de déploiement du webhook. Si cette règle n'est pas configurée, le point de terminaison n'est pas authentifié.
Unset_deploy_secret
booléen
(Écriture seule) Lorsque la valeur est "true", le secret est déployé, de manière à autoriser l'accès non authentifié au point de terminaison du déploiement du webhook.
mode_demande_extraction
string
Stratégie de requête git pull pour ce projet. Les valeurs valides sont "off", "links", "recommended" et "required".
validation_obligatoire
booléen
Stratégie de validation: si la valeur est "true", le projet doit passer avec succès les contrôles de validation avant que les modifications ne puissent être validées dans le dépôt Git.
git_release_mgmt_enabled
booléen
Si la valeur est "true", la gestion avancée des versions Git est activée pour ce projet
autorisation_avertissements
booléen
Stratégie de validation: si la valeur est "true", le projet peut être validé avec des avertissements lorsque "validation_required" est défini sur "true". ("allow_warnings" n'a aucun effet si "validation_required" est défini sur "false".
exemple_est
booléen
Si la valeur est "true", le projet est un exemple et ne peut pas être modifié

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