Criar ou atualizar artefatos

Versão 4.0.23.4

Criar ou atualizar um ou mais artefatos

Somente key e value são necessários para criar um artefato. Para atualizar um artefato, seu valor version atual precisa ser fornecido.

No payload body de exemplo a seguir, one e two são artefatos existentes, e three é novo:

[
  { "key": "one", "value": "[ \"updating\", \"existing\", \"one\" ]", "version": 10, "content_type": "application/json" },
  { "key": "two", "value": "updating existing two", "version": 20 },
  { "key": "three", "value": "creating new three" },
]

Observações para este corpo:

  • O value para key um é um payload JSON, então uma substituição content_type é necessária. Essa substituição precisa ser feita toda vez que um valor JSON é definido.
  • Os valores version para um e dois significam que foram salvos 10 e 20 vezes, respectivamente.
  • Se version não for fornecido para um artefato existente, toda a solicitação será recusada e uma resposta Bad Request será enviada.
  • Se version for fornecido para um artefato, ele será usado apenas para ajudar a evitar substituições acidentais de dados. Ela não pode ser usada para definir a versão de um artefato. O servidor do Looker controla version.
  • Sugerimos a codificação de valores binários como base64. Como o tipo de conteúdo MIME para base64 é detectado como texto simples, forneça também content_type para indicar corretamente o tipo de valor para recuperação e processamento no lado do cliente.

Como os artefatos são armazenados criptografados, o mesmo valor pode ser gravado várias vezes, desde que o número version correto seja usado. O Looker não examina nenhum valor armazenado no armazenamento de artefatos e só descriptografa ao enviar artefatos de volta em uma resposta da API.

Observação: a API Artifact Storage só pode ser usada por extensões criadas pelo Looker.

Solicitação

PUT /artifacts/{namespace}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
namespace
string
Namespace do armazenamento de artefatos
body
Corpo HTTP
Expandir definição HTTPBody...
Expandir definição de UpdateArtifact...
chave
string
Chave do valor a ser armazenado. O namespace e a chave precisam ser exclusivos.
valor
string
Valor a ser armazenado.
content_type
string
Tipo MIME de conteúdo. Isso só pode ser usado para substituir conteúdo detectado como texto/simples. Necessário para definir tipos de conteúdo de aplicativo/json que são analisados como texto simples.
version
integer
Número da versão do valor armazenado. A versão precisa ser fornecida para todas as atualizações de um artefato existente.
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Nomes de campos delimitados por vírgulas a serem retornados nas respostas. Omitir para todos os campos

Resposta

200: artefatos criados ou atualizados

Tipo de dados
Descrição
(matriz)
chave
string
Chave do valor a ser armazenado. O namespace e a chave precisam ser exclusivos.
valor
string
Valor a ser armazenado.
content_type
string
Tipo MIME de conteúdo. Isso só pode ser usado para substituir conteúdo detectado como texto/simples. Necessário para definir tipos de conteúdo de aplicativo/json que são analisados como texto simples.
version
integer
Número da versão do valor armazenado. A versão precisa ser fornecida para todas as atualizações de um artefato existente.
namespace
string
Namespace de armazenamento do artefato.
criado_em
string
Carimbo de data/hora de criação do artefato.
atualizado em
string
Carimbo de data/hora de quando este artefato foi atualizado.
value_size
integer
Tamanho (em bytes) do valor armazenado.
criado_por_usuário
string
ID do usuário do criador de artefatos.
atualizado_por_usuario
string
ID do usuário do atualizador de artefatos.

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

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

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