Artefakte erstellen oder aktualisieren

Version 4.0.23.6 (neueste Version)

Ein oder mehrere Artefakte erstellen oder aktualisieren

Zum Erstellen eines Artefakts sind nur key und value erforderlich. Zum Aktualisieren eines Artefakts muss der aktuelle version-Wert angegeben werden.

Im folgenden Beispiel sind body-Nutzlast, one und two vorhandene Artefakte und three ist neu:

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

Hinweise für diesen Text:

  • value für key eine ist eine JSON-Nutzlast. Es ist also eine content_type-Überschreibung erforderlich. Diese Überschreibung muss immer erfolgen, wenn ein JSON-Wert festgelegt wird.
  • Die version-Werte für one und two bedeuten, dass sie 10 bzw. 20 Mal gespeichert wurden.
  • Wenn version für ein vorhandenes Artefakt nicht angegeben wird, wird die gesamte Anfrage abgelehnt und eine Bad Request-Antwort gesendet.
  • Wenn version für ein Artefakt angegeben ist, wird damit nur verhindert, dass versehentliche Daten überschrieben werden. Es kann nicht zum Festlegen der Version eines Artefakts verwendet werden. Der Looker-Server steuert version.
  • Wir empfehlen, Binärwerte als base64 zu codieren. Da der MIME-Inhaltstyp für base64 als Nur-Text erkannt wird, geben Sie content_type an, damit der Werttyp für den Abruf und die clientseitige Verarbeitung korrekt angegeben wird.

Da Artefakte verschlüsselt gespeichert werden, kann derselbe Wert mehrmals geschrieben werden, sofern die richtige version-Nummer verwendet wird. Looker untersucht keine im Artefaktspeicher gespeicherten Werte und entschlüsselt sie nur, wenn Artefakte in einer API-Antwort zurückgesendet werden.

Hinweis: Die Artifact Storage API kann nur von von Looker erstellten Erweiterungen verwendet werden.

Anfrage

PUT /Artefakte/{Namespace}
Datentyp
Beschreibung
Anfrage
HTTPRequest
Pfad
HTTPPath
HTTPPath-Definition maximieren...
Namespace
String
Artefaktspeicher-Namespace
body
HTTP-Text
HTTPBody-Definition maximieren...
UpdateArtifact-Definition maximieren...
Schlüssel
String
Zu speichernder Wert. Namespace + Schlüssel muss eindeutig sein.
Wert
String
Zu speichernder Wert.
content_type
String
MIME-Typ des Inhalts. Dies kann nur zum Überschreiben von Inhalten verwendet werden, die als Text/einfach erkannt werden. Erforderlich, um Anwendungs-/JSON-Inhaltstypen festzulegen, die als reiner Text analysiert werden.
version
integer
Versionsnummer des gespeicherten Werts. Die Version muss für alle Aktualisierungen eines vorhandenen Artefakts angegeben werden.
Abfrage
HTTP-Abfrage
HTTPQuery-Definition maximieren...
Felder
String
Durch Kommas getrennte Namen von Feldern, die in Antworten zurückgegeben werden sollen. Für alle Felder weglassen

Antwort

200: Artefakte erstellt oder aktualisiert

Datentyp
Beschreibung
(Array)
Schlüssel
String
Zu speichernder Wert. Namespace + Schlüssel muss eindeutig sein.
Wert
String
Zu speichernder Wert.
content_type
String
MIME-Typ des Inhalts. Dies kann nur zum Überschreiben von Inhalten verwendet werden, die als Text/einfach erkannt werden. Erforderlich, um Anwendungs-/JSON-Inhaltstypen festzulegen, die als reiner Text analysiert werden.
version
integer
Versionsnummer des gespeicherten Werts. Die Version muss für alle Aktualisierungen eines vorhandenen Artefakts angegeben werden.
Namespace
String
Artefaktspeicher-Namespace.
erstellt am
String
Zeitstempel für das Erstellen dieses Artefakts.
Aktualisiert am
String
Zeitstempel für die Aktualisierung dieses Artefakts.
value_size
integer
Größe (in Byte) des gespeicherten Werts
von_nutzer_id erstellt
String
Nutzer-ID des Artefakt-Erstellers.
aktualisiert_von_userid
String
Nutzer-ID des Artefakt-Updaters.

400: Ungültige Anfrage

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

404: Nicht gefunden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

422: Validierungsfehler

Datentyp
Beschreibung
nachricht
String
Fehlerdetails
ValidationErrorDetail-Definition maximieren...
Feld
String
Feld mit Fehler
Code
String
Fehlercode
nachricht
String
Fehlermeldung
Dokumentations-URL
String
Link zur Dokumentation
Dokumentations-URL
String
Link zur Dokumentation

429: Zu viele Anfragen

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation