Aktualisieren eines Katalogobjekts
Sie können einen Teil eines Catalog -Objekt, indem die zugehörige ID in den Pfad einer PATCH-Anfrage aufgenommen wird. 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
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}
{OBJECT_TYPE}
Der Typ von Catalog -Objekt zu aktualisieren. Gültige Objekte sind:
batches
dataSets
dataSetFiles
{OBJECT_ID}
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: {ORG_ID}' \
-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.
Weitere Informationen zur JSON Patch-Syntax finden Sie unter API-Grundlagenhandbuch.
API-Format
PATCH /{OBJECT_TYPE}/{OBJECT_ID}
{OBJECT_TYPE}
Der Typ von Catalog -Objekt zu aktualisieren. Gültige Objekte sind:
batches
dataSets
dataSetFiles
{OBJECT_ID}
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: {ORG_ID}' \
-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"
]