Scegli Workspace

Versione 4.0.23.6 (più recente)

Scegli uno spazio di lavoro

Restituisce le informazioni su un'area di lavoro, come lo stato Git e i rami selezionati di tutti i progetti disponibili per l'account utente del chiamante.

Un'area di lavoro definisce le versioni dei file di progetto che verranno utilizzate per valutare le espressioni e le operazioni che utilizzano le definizioni del modello, incluse operazioni come l'esecuzione di query o le dashboard di rendering. Ogni progetto ha il proprio repository Git e ogni progetto in un'area di lavoro può essere configurato in modo da fare riferimento a un ramo o a una revisione specifici all'interno dei rispettivi repository.

Sono disponibili due aree di lavoro predefinite: "production" e "dev".

L'area di lavoro di produzione è condivisa tra tutti gli utenti di Looker. I modelli nell'area di lavoro di produzione sono di sola lettura. La modifica dei file in produzione viene eseguita modificando i file in un ramo git e utilizzando le richieste di pull per unire le modifiche dal ramo dev nel ramo production e quindi indicare a Looker di eseguire la sincronizzazione con il ramo production.

L'area di lavoro dev è locale per ogni utente Looker. Le modifiche apportate ai file di progetto/modello nell'area di lavoro dev'interessano solo quell'utente e solo quando quest'ultima è selezionata come area di lavoro attiva per la sessione API. (Vedi set_session_workspace()).

L'area di lavoro dev NON è univoca per una sessione API. Due applicazioni che accedono all'API Looker utilizzando lo stesso account utente vedranno gli stessi file nell'area di lavoro di sviluppo. Per evitare conflitti tra i client API, è preferibile fare in modo che ogni client acceda con credenziali API per un account utente diverso.

Le modifiche apportate ai file in un'area di lavoro dev sono persistenti tra le sessioni API. È buona prassi eseguire il commit delle modifiche apportate al repository Git, ma non strettamente obbligatorie. I file modificati si trovano in una directory specifica per l'utente sul server Looker e saranno ancora disponibili quando accedi di nuovo in seguito e utilizzi update_session(workspace_id: "dev") per selezionare l'area di lavoro dev per la nuova sessione API.

Richiesta

GET /workspaces/{workspace_id}
Tipo di dati
Descrizione
Richiesta
HTTPRequest
percorso
Percorso HTTP
Espandi definizione HTTPPath...
ID_area di lavoro
string
ID dell'area di lavoro

Risposta

200: Workspace

Tipo di dati
Descrizione
(oggetto)
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto
id
string
L'ID univoco dell'area di lavoro dell'utente. Gli ID area di lavoro predefiniti includono "production" e "dev"
projects
Espandi definizione progetto...
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto
id
string
ID progetto
name
string
Nome visualizzato del progetto
utilizza_git
boolean
Se true, il progetto è configurato con un repository Git
url_git_remoto
string
URL repository remoto Git
nomeutente_git
string
Nome utente Git per l'autenticazione HTTPS. (solo per la produzione, se si utilizzano attributi utente).
password_git
string
(Solo scrittura) Password Git per l'autenticazione HTTPS. (solo per la produzione, se si utilizzano attributi utente).
git_production_branch_name
string
Nome ramo produzione Git. I valori predefiniti sono impostati come master. È supportato solo in Looker 21.0 e versioni successive.
utilizza_autenticazione_cookie_git
boolean
Se true, il progetto utilizza un cookie Git per l'autenticazione.
attributo_utente_nomeutente_git
string
Nome dell'attributo utente per il nome utente nell'autenticazione HTTPS per utente.
git_password_user_attribute
string
Nome dell'attributo utente per la password nell'autenticazione HTTPS per utente.
nome_servizio_git
string
Nome del fornitore di servizi Git
git_application_server_http_port
integer
Porta su cui è in esecuzione il server di applicazioni HTTP(S), ad esempio PR, navigazione dei file e così via
git_application_server_http_scheme
string
Schema in esecuzione sul server di applicazioni (per PR, navigazione di file ecc.)
deployment_segreto
string
(Solo scrittura) Token del secret facoltativo con cui autenticare le richieste all'endpoint di deployment del webhook. Se non viene impostato, l'endpoint non è autenticato.
unset_deploy_secret
boolean
(Solo scrittura) Se true, annulla il secret del deployment per consentire l'accesso non autenticato all'endpoint di deployment webhook.
modalità_richiesta_di_pull
string
Il criterio di richiesta pull di Git per questo progetto. I valori validi sono: "off", "links", "recommended", "required".
convalida_obbligatoria
boolean
Criterio di convalida: se vero, il progetto deve superare i controlli di convalida prima che le modifiche al progetto possano essere sottoposte a commit nel repository Git
git_release_mgmt_attivata
boolean
Se true, la gestione delle release Git avanzate è abilitata per questo progetto
allow_warnings
boolean
Criterio di convalida: se vero, è possibile eseguire il commit del progetto con avvisi quando "validation_required" è vero. ("allow_warnings" non fa nulla se "validation_required") è false.
è_esempio
boolean
Se true, il progetto è un progetto di esempio e non può essere modificato
stato_dipendenza
string
Stato delle dipendenze nel manifest e nel file di blocco

400: Richiesta errata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

404: Non trovata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

Esempi