Usar o Workspace

Versão 3.1.23.4

Comprar um espaço de trabalho

Retorna informações sobre um espaço de trabalho, como o status do git e as ramificações selecionadas de todos os projetos disponíveis para a conta de usuário do autor da chamada.

Um espaço de trabalho define quais versões dos arquivos do projeto serão usadas para avaliar expressões e operações que usam definições de modelo, como operações de execução ou painéis de renderização. Cada projeto tem o próprio repositório git, e cada projeto em um espaço de trabalho pode ser configurado para fazer referência a uma ramificação ou revisão específica nos respectivos repositórios.

Há dois espaços de trabalho predefinidos disponíveis: "production" e "dev".

O espaço de trabalho de produção é compartilhado por todos os usuários do Looker. Os modelos no espaço de trabalho de produção são somente leitura. A alteração de arquivos na produção é realizada modificando arquivos em um branch do git e usando solicitações de envio para mesclar as alterações do branch de desenvolvimento no branch de produção e, em seguida, informando ao Looker para sincronizar com a produção.

O espaço de trabalho de desenvolvimento é local para cada usuário do Looker. As alterações feitas nos arquivos do projeto/modelo no espaço de trabalho de desenvolvimento só afetam esse usuário e apenas quando ele é selecionado como o espaço de trabalho ativo para a sessão da API. (consulte set_session_workspace()).

O espaço de trabalho de desenvolvimento NÃO é exclusivo para uma sessão da API. Dois aplicativos que acessam a API Looker usando a mesma conta de usuário verão os mesmos arquivos no espaço de trabalho de desenvolvimento. Para evitar colisões entre os clientes de API, é melhor que cada cliente faça login com as credenciais da API 3 para uma conta de usuário diferente.

As alterações feitas nos arquivos em um espaço de trabalho de desenvolvimento são persistentes em sessões de API. É uma boa ideia confirmar qualquer alteração feita no repositório git, mas isso não é obrigatório. Seus arquivos modificados residem em um diretório especial específico do usuário no servidor Looker e ainda estarão lá quando você fizer login novamente mais tarde e usar update_session(workspace_id: "dev") para selecionar o espaço de trabalho de desenvolvimento para a nova sessão da API.

Solicitação

GET /workspaces/{workspace_id}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
ID do espaço de trabalho
string
ID do espaço de trabalho

Resposta

200: espaço de trabalho

Tipo de dados
Descrição
(objeto)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
O ID exclusivo desse espaço de trabalho do usuário. Os IDs predefinidos do espaço de trabalho incluem "production" e "dev"
projects
Expandir a definição do projeto...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID do projeto
nome
string
Nome de exibição do projeto
usa_git
booleano
Se verdadeiro, o projeto é configurado com um repositório git
git_remote_url
string
URL do repositório remoto do Git
git_username
string
Nome de usuário do Git para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_password
string
Senha do Git (somente gravação) para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_production_branch_name
string
Nome da ramificação de produção do Git. O padrão é o mestre. Compatível apenas com o Looker 21.0 e versões mais recentes.
use_git_cookie_auth
booleano
Se verdadeiro, o projeto usa um cookie git para autenticação.
git_username_user_attribute
string
Nome do atributo do usuário para o nome de usuário na autenticação HTTPS por usuário.
git_password_user_attribute
string
Nome do atributo do usuário para senha na autenticação HTTPS por usuário.
git_service_name
string
Nome do provedor de serviços Git
git_application_server_http_port
integer
Porta em que o servidor de aplicativos HTTP(S) está sendo executado (para PRs, navegação de arquivos etc.)
git_application_server_http_scheme
string
Scheme executado no servidor de aplicativos (para PRs, navegação de arquivos etc.)
implantar_secreto
string
(Somente gravação) Token confidencial opcional com o qual autenticar solicitações para o endpoint de implantação do webhook. Se não for definido, o endpoint não será autenticado.
Não definido, implantar
booleano
(Somente gravação) Quando verdadeiro, cancela a configuração do secret de implantação para permitir acesso não autenticado ao endpoint de implantação do webhook.
modo_de_solicitação_de_pull
string
A política de solicitação de envio do Git para este projeto. Os valores válidos são: "off", "links", "recommended", "required".
validação_obrigatória
booleano
Política de validação: se verdadeiro, o projeto precisa ser aprovado nas verificações de validação antes que as alterações do projeto possam ser confirmadas no repositório git
git_release_mgmt_enabled
booleano
Se verdadeiro, o gerenciamento avançado de versões do git está ativado neste projeto.
allow_warnings
booleano
Política de validação: se verdadeiro, o projeto poderá ser confirmado com avisos quando "validation_required" for verdadeiro. "allow_warnings" não terá efeito se "validation_required" for falso.
exemplo_is
booleano
Se for "true", o projeto é um exemplo e não pode ser modificado

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples