Créer ou mettre à jour des artefacts

Version 4.0.23.4

Créer ou mettre à jour un ou plusieurs artefacts

Seuls key et value sont requis pour créer un artefact. Pour mettre à jour un artefact, sa valeur version actuelle doit être fournie.

Dans l'exemple de charge utile body, one et two sont des artefacts existants, et three est nouveau:

[
  { "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" },
]

Remarques pour ce corps:

  • Le value pour key one est une charge utile JSON. Un remplacement de content_type est donc nécessaire. Ce remplacement doit être effectué chaque fois qu'une valeur JSON est définie.
  • Les valeurs version pour un et deux signifient respectivement qu'elles ont été enregistrées 10 et 20 fois.
  • Si version n'est pas fourni pour un artefact existant, l'intégralité de la requête sera refusée et une réponse Bad Request sera envoyée.
  • Si version est fourni pour un artefact, il ne sert qu'à éviter le remplacement involontaire de données. Elle ne peut pas être utilisée pour définir la version d'un artefact. Le serveur Looker contrôle version.
  • Nous vous suggérons d'encoder des valeurs binaires en base64. Étant donné que le type de contenu MIME pour le code base64 est détecté comme texte brut, fournissez également content_type pour indiquer correctement le type de valeur pour la récupération et le traitement côté client.

Les artefacts étant chiffrés, la même valeur peut être écrite plusieurs fois (à condition d'utiliser le bon nombre version). Looker n'examine pas les valeurs stockées dans le magasin d'artefacts et ne les déchiffre que lors du renvoi d'artefacts dans une réponse d'API.

Remarque: L'API Artifact Storage ne peut être utilisée que par les extensions créées par Looker.

Demande

PUT /Artifacts/{namespace}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
espace de noms
string
Espace de noms de l'artefact de stockage
body
Corps HTTP
Développer la définition HTTPBody...
Développer la définition de "UpdateArtifact"...
clé
string
Clé de valeur à stocker. L'espace de noms et la clé doivent être uniques.
valeur
string
Valeur à stocker.
content_type
string
Type de contenu MIME. Elle ne peut être utilisée que pour remplacer le contenu détecté comme étant au format texte/plain. Nécessaire pour définir des types de contenus d'application/json, qui sont analysés en texte brut.
version
integer
Numéro de version de la valeur stockée. La version doit être fournie pour toute mise à jour d'un artefact existant.
query
Requête HTTP
Développer la définition de la requête HTTP...
champs
string
Noms des champs séparés par une virgule à renvoyer dans les réponses. Omettre pour tous les champs

Réponse

200: artefacts créés ou mis à jour

Type de données
Description
(tableau)
clé
string
Clé de valeur à stocker. L'espace de noms et la clé doivent être uniques.
valeur
string
Valeur à stocker.
content_type
string
Type de contenu MIME. Elle ne peut être utilisée que pour remplacer le contenu détecté comme étant au format texte/plain. Nécessaire pour définir des types de contenus d'application/json, qui sont analysés en texte brut.
version
integer
Numéro de version de la valeur stockée. La version doit être fournie pour toute mise à jour d'un artefact existant.
espace de noms
string
Espace de noms de l'artefact de stockage.
créé le
string
Horodatage de la création de cet artefact.
mis à jour le
string
Horodatage de la mise à jour de cet artefact.
size_size [taille_valeur]
integer
Taille (en octets) de la valeur stockée.
Créé par
string
ID utilisateur du créateur de l'artefact.
mis à jour par l'ID utilisateur
string
ID utilisateur du programme de mise à jour des artefacts.

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

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation