Aktualisieren eines Katalogobjekts

Sie können einen Teil eines Catalog-Objekts aktualisieren, indem Sie dessen Kennung in den Pfad einer PATCH-Anfrage einschließen. In diesem Dokument werden die beiden Methoden zum Ausführen von PATCH-Vorgängen für Katalogobjekte behandelt:

  • Verwenden von Feldern
  • Verwenden der JSON Patch-Notation
HINWEIS

PATCH-Vorgänge können die erweiterbaren Felder eines Objekts, die miteinander verknüpfte Objekte darstellen, nicht ändern. Änderungen an verknüpften Objekten müssen direkt vorgenommen werden.

Aktualisieren mithilfe von Feldern

Der folgende Beispielaufruf zeigt, wie ein Objekt mithilfe von Feldern und Werten aktualisiert wird.

API-Format

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parameter Beschreibung
{OBJECT_TYPE} Der Typ des zu aktualisierenden Catalog -Objekts. Gültige Objekte sind:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Die Kennung des spezifischen Objekts, das Sie aktualisieren möchten.

Anfrage

Die folgende Anfrage aktualisiert die name- und description-Felder eines Datensatzes auf die in der Payload bereitgestellten Werte. Objektfelder, die nicht aktualisiert werden sollen, können von der Payload ausgeschlossen werden.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "name":"Updated Dataset Name",
       "description":"Updated description for Sample Dataset"
      }'

Antwort

Eine erfolgreiche Antwort gibt ein Array zurück, das die ID des aktualisierten Datensatzes enthält. Diese ID sollte mit der in der PATCH-Anfrage gesendeten ID übereinstimmen. Die Ausführung einer GET-Anfrage für diesen Datensatz zeigt jetzt, dass nur name und description aktualisiert wurden, während alle anderen Werte unverändert bleiben.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Aktualisieren mithilfe der JSON Patch-Notation

Der folgende Beispielaufruf zeigt, wie ein Objekt, wie in RFC-6902 beschrieben, mit JSON Patch aktualisiert wird.

API-Format

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parameter Beschreibung
{OBJECT_TYPE} Der Typ des zu aktualisierenden Catalog -Objekts. Gültige Objekte sind:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Die Kennung des spezifischen Objekts, das Sie aktualisieren möchten.

Anfrage

Die folgende Anfrage aktualisiert die name- und description-Felder eines Datensatzes auf die Werte, die in jedem JSON Patch-Objekt angegeben sind. Bei Verwendung von JSON Patch müssen Sie auch die Kopfzeile für den Inhaltstyp auf application/json-patch+json setzen.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
        { "op": "add", "path": "/name", "value": "New Dataset Name" },
        { "op": "add", "path": "/description", "value": "New description for dataset" }
      ]'

Antwort

Eine erfolgreiche Antwort gibt ein Array zurück, das die ID des aktualisierten Objekts enthält. Diese ID sollte mit der in der PATCH-Anfrage gesendeten ID übereinstimmen. Die Ausführung einer GET-Anfrage für dieses Objekt zeigt jetzt, dass nur name und description aktualisiert wurden, während alle anderen Werte unverändert bleiben.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Auf dieser Seite